<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.7.0" />

	<title>Class MessageException | nort</title>

	<script type="text/javascript" src="resources/combined.js?1481722677"></script>
	<script type="text/javascript" src="elementlist.js?1094816827"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?1567499433" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Packages</h3>
			<ul>
				<li><a href="package-App.html">App<span></span></a>
						<ul>
				<li><a href="package-App.Saas.html">Saas</a>
						</li>
				<li><a href="package-App.saas.html">saas</a>
						</li>
				<li><a href="package-App.SaaS.html">SaaS<span></span></a>
						<ul>
				<li><a href="package-App.saas.Logic.html">Logic</a>
						</li>
				<li><a href="package-App.SaaS.SaaS.html">SaaS</a>
						</li>
				<li><a href="package-App.Saas.Tables.html">Tables</a>
						</li>
				<li><a href="package-App.Saas.Vo.html">Vo</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-aqua.html">aqua<span></span></a>
						<ul>
				<li><a href="package-aqua.tools.html">tools<span></span></a>
						<ul>
				<li><a href="package-aqua.tools.Monitor.html">Monitor</a>
						</li>
							</ul></li></ul></li>
				<li class="active"><a href="package-flashservices.html">flashservices<span></span></a>
						<ul>
				<li><a href="package-flashservices.adapters.html">adapters</a>
						</li>
				<li><a href="package-flashservices.debug.html">debug</a>
						</li>
				<li class="active"><a href="package-flashservices.exception.html">exception</a>
						</li>
				<li><a href="package-flashservices.filters.html">filters</a>
						</li>
				<li><a href="package-flashservices.io.html">io</a>
						</li>
				<li><a href="package-flashservices.sql.html">sql</a>
						</li>
				<li><a href="package-flashservices.util.html">util</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.html">Mekayotl<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.core.html">core</a>
						</li>
				<li><a href="package-Mekayotl.database.html">database<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.database.dal.html">dal</a>
						</li>
				<li><a href="package-Mekayotl.database.mysql.html">mysql</a>
						</li>
				<li><a href="package-Mekayotl.database.sqlite.html">sqlite</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.tools.html">tools<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.tools.render.html">render<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.tools.render.html.html">html</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.tools.renders.html">renders</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-None.html">None</a>
						</li>
				<li><a href="package-PHP.html">PHP</a>
						</li>
				<li><a href="package-PHPMailer.html">PHPMailer</a>
						</li>
				<li><a href="package-Services.html">Services<span></span></a>
						<ul>
				<li><a href="package-Services.JSON.html">JSON</a>
						</li>
							</ul></li>
				<li><a href="package-Swift.html">Swift<span></span></a>
						<ul>
				<li><a href="package-Swift.ByteStream.html">ByteStream</a>
						</li>
				<li><a href="package-Swift.CharacterStream.html">CharacterStream</a>
						</li>
				<li><a href="package-Swift.Encoder.html">Encoder</a>
						</li>
				<li><a href="package-Swift.Events.html">Events</a>
						</li>
				<li><a href="package-Swift.KeyCache.html">KeyCache</a>
						</li>
				<li><a href="package-Swift.Mailer.html">Mailer</a>
						</li>
				<li><a href="package-Swift.Mime.html">Mime</a>
						</li>
				<li><a href="package-Swift.Plugins.html">Plugins</a>
						</li>
				<li><a href="package-Swift.Transport.html">Transport</a>
						</li>
							</ul></li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li class="active"><a href="class-MessageException.html">MessageException</a></li>
			</ul>



			<h3>Exceptions</h3>
			<ul>
				<li><a href="class-VerboseException.html">VerboseException</a></li>
			</ul>


		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="package-flashservices.exception.html" title="Summary of flashservices\exception"><span>Package</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class MessageException</h1>











	<div class="info">
		
		
		
		<b>Package:</b> <a href="package-flashservices.html">flashservices</a>\<a href="package-flashservices.exception.html">exception</a><br />

				<b>Copyright:</b>
				(c) 2003 amfphp.org<br />
				<b>License:</b>
				<a href="http://opensource.org/licenses/gpl-license.php">GNU Public License</a><br />
				<b>Author:</b>
				Justin Watkins Original Design<br />
		<b>Located at</b> <a href="source-class-MessageException.html#25" title="Go to source code">lib/php/externals/amfphp/core/shared/exception/MessageException.php</a><br />
	</div>


	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="MessageException" id="_MessageException">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_MessageException">#</a>
		<code><a href="source-class-MessageException.html#28" title="Go to source code">MessageException</a>( <span>string <var>$code</var></span>, <span>string <var>$description</var></span>, <span>string <var>$file</var></span>, <span>integer <var>$line</var></span>, <span> <var>$detailCode</var> = <span class="php-quote">'AMFPHP_RUNTIME_ERROR'</span></span> )</code>

		<div class="description short">
			
<p>Constructor for the Exception class. This is how you build a new error
instance.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Constructor for the Exception class. This is how you build a new error
instance.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$code</var></dt>
					<dd><code>string</code><br> The code string to return to the flash client :: THIS SHOULD PROBABLY BE SET
AUTOMATICALLY ::</dd>
					<dt><var>$description</var></dt>
					<dd><code>string</code><br> A short reason why the error occured</dd>
					<dt><var>$file</var></dt>
					<dd><code>string</code><br> The file name that the error occured</dd>
					<dt><var>$line</var></dt>
					<dd><code>integer</code><br> The line number where the error was detected</dd>
					<dt><var>$detailCode</var></dt>
					<dd></dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="throwException" id="_throwException">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_throwException">#</a>
		<code><a href="source-class-MessageException.html#47" title="Go to source code">throwException</a>( <span>AMFBody <var>&amp; $body</var></span>, <span>AMFException <var>$exception</var></span> )</code>

		<div class="description short">
			
<p>throwException provides the means to raise an exception. This method will
stop the further execution of the remote method, but not hault the execution of
the entire process. Using the built in PHP exception system will stop the entire
process and not allow us to report very detailed information back to the client,
especially if there are multiple methods.</p>

		</div>

		<div class="description detailed hidden">
			
<p>throwException provides the means to raise an exception. This method will
stop the further execution of the remote method, but not hault the execution of
the entire process. Using the built in PHP exception system will stop the entire
process and not allow us to report very detailed information back to the client,
especially if there are multiple methods.</p>

<p>When we upgrade to PHP 5, using the try...catch syntax will make this much
easier.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$body</var></dt>
					<dd><code>AMFBody</code><br> The AMFBody object to apply the exception to.</dd>
					<dt><var>$exception</var></dt>
					<dd><code>AMFException</code><br>@exception The exception object to throw</dd>
				</dl></div>



				<h4>See</h4>
				<div class="list">
						AMFBody<br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="getFriendlyError" id="_getFriendlyError">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getFriendlyError">#</a>
		<code><a href="source-class-MessageException.html#87" title="Go to source code">getFriendlyError</a>( <span> <var>$err</var></span> )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			







		</div>
		</div></td>
	</tr>
	</table>










</div>

	<div id="footer">
		nort API documentation generated by <a href="http://apigen.org">ApiGen 2.7.0</a>
	</div>
</div>
</div>
</body>
</html>
